/*
 * Copyright (c) 2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.libermundi.tapestry.elfinder.services;

import java.util.List;

/**
 * Simple Service Interface designed to return the list of available {@link Volume}s for ElFinder 
 * @author Martin Papy
 *
 */
public interface VolumeSource {
	
	/**
	 * 
	 * @param volume
	 */
	public void add(Volume volume);
	
	/**
	 * 
	 * @param volume
	 * @param isdefault
	 */
	public void add(Volume volume, boolean isdefault);
	
	/**
	 * Set the provided {@link Volume} as Default. If the {@link Volume} was not added already, then
	 * add the {@link Volume}
	 * @param volume
	 */
	public void setDefault(Volume volume);
	
	/**
	 * 
	 * @return
	 */
	public List<Volume> getVolumes();

	/**
	 * @param targetHash
	 * @return
	 */
	public Volume getVolumeFromHash(String targetHash);

	/**
	 * Returns the default {@link Volume} if defined, the first {@link Volume} added if not
	 * @return the default {@link Volume}
	 */
	public Volume getDefaultVolume();

}
